home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / BARNET / FREENET / SMITH / FREENEWS.SPK / !FreeNews / !Help < prev    next >
Text File  |  1995-11-12  |  12KB  |  278 lines
  1. Installation guidelines for FreeNews
  2. ====================================
  3.  
  4. (file last updated Sun 12th November 1995 to cope with FreeNews 1.01).
  5.  
  6. NOTE
  7. ----
  8. FreeNews version 1.01 is a RELEASE version of the Freenet NNTP news fetcher.
  9.  
  10. However, no NNTP news system can ever be perfect, as news is propagated from 
  11. machine to machine across the internet. If you want any guarantees that all of
  12. the relevant news is downloaded, then sorry, but none will be forthcoming.
  13.  
  14. I have (and many alpha and beta testers have too) tested FreeNews quite 
  15. considerably over the last few months, and although far from being complete
  16. (I'm already working on version 1.10, with version 2.00 in the planning stage),
  17. it is certainly as usable as KA9Q, and about the same speed (see below).
  18.  
  19.  
  20. Known Bugs
  21. ----------
  22.  
  23. * Version 1.00 of FreeNews calculated the cps figure strangely, so it understated
  24.   the speed it now obtains. It (unlike KA9Q and SLIPdial) calculates
  25.   speed from the very start of the fetch until <now>. FreeNews 1.01 now calculates
  26.   using a much smaller timespan to average over (8 seconds). The cps figures
  27.   shown are the newer version with the old method in brackets for reference.
  28.   NB actual speed has not changed between 1.00 and 1.01, just the method of
  29.   calculating it.
  30.  
  31. * Very occasionally, the lower two lines in the status window are not updated,
  32.   even though transfer is actually happenning. If anyone can get a lead on this,
  33.   please let me know.
  34.  
  35. * There are a couple of problems with the Newsbase transport system; these
  36.   require mods to be made to Newsbase. Basically, Newsbase/Groups sometimes
  37.   think that a group has not been added to the newsfeed. Don't worry though,
  38.   as it will have been.
  39.  
  40. * "nager:Sprites22". This is an Acorn bug caused by problems surrounding the
  41.   Drawfile module and the toolbox. Make sure that you have the latest versions
  42.   of both these modules in System:modules, and THAT YOU REPLACE ALL OLDER VERSIONS
  43.   that may be in various subdirectories on your machine. Most people report
  44.   that they are surprised how many copies of Drawfile they have!
  45.   
  46. * RISC OS 3.60 USERS: You have an older version of some of the toolbox modules
  47.   in ROM than FreeNews needs. If they are in use, FreeNews is unable to replace
  48.   them with the new versions. If problems (such as "nager:Sprites22") persist,
  49.   try *Unplugging the version in ROM.
  50.  
  51. * Auto-start/quit currently have problems occasionally, specifically when
  52.   there is a problem with the initial connection to the server. My advice is
  53.   not to use these options at the moment unless you absolutely need to.
  54.  
  55. * Auto-retry of connection to a news server works fine in development, but seems
  56.   a little flaky in the real world. If you have problems, simply quit and restart
  57.   FreeNews. Version 1.02 should include a new way of implementing this, so 
  58.   please be patient.
  59.   
  60. If you are unfortunate enough to come across any other bugs, or you have any
  61. comments or requests for inclusion in future versions, please email details
  62. to freenews@roundel.demon.co.uk. Thanks.
  63.  
  64.  
  65. Distribution files
  66. ------------------
  67. !FreeNews
  68.     !Boot        - Filer boot file.
  69.     !Help          - This file!
  70.     !Run        - App. startup file. You may need to edit Wimpslot.
  71.               please let me know if you do.
  72.     !RunImage    - Application executable.
  73.     !Sprites    - Wimp icons.
  74.     !Sprites22    - High resolution wimp icons.
  75.     Acknowledge    - Acknowlegements.
  76.     Advanced    - Instructions for "Advanced Configuration".
  77.     
  78.     Data        - Directory containing files needed at runtime.
  79.        AllGroups      - list of groups to fetch all new news from.
  80.        Config      - FreeNews configuration.
  81.        History      - List of message ids that have been fetched.
  82.        NewGroups      - FreeNews puts any New Groups found in here.
  83.        NewIDs      - Message ids of news to be fetched this run.
  84.                    (maintained by FreeNews. Do not edit).
  85.        PostIndex      - List of filenames containing messages to post.
  86.        *~          - Previous version (backup) of file *.
  87.        
  88.     History        - History of bug fixes, releases, and fixes awaiting
  89.               implementation.
  90.     Messages    - Wimp Messages
  91.     Res        - Acorn Toolbox application resource file (UK).
  92.               If anyone wants a decompiled version so that they
  93.               can translate it to another language, please let me know
  94.               as I'd be very glad to help.
  95.     
  96. !NewsBase
  97.     Transports
  98.         freenews (full dir)
  99.             - This is NOT a full release of Newsbase, but a set of
  100.               "transport" files to interface FreeNews with Newsbase.
  101.               To install it, simply drag the !Newsbase from the
  102.               FreeNews distribution over your master copy of Newsbase
  103.               if you use it. Ignore this if you don't. 
  104.               
  105.               IMPORTANT - follow the instructions in "Setting up"
  106.               below to make NewsBase work with this transport.
  107.  
  108. !Syslog (app)        - Stewart Brodie's system log utility. The version that 
  109.               I supply may not be the latest, but it will work with
  110.               FreeNews. You should find the latest version at
  111.               ftp://cslib.ecs.soton.ac.uk/pub/Acorn/freenet/s.n.brodie
  112.               
  113.               Any significant actions that FreeNews does get logged
  114.               in the system_log file in this directory.
  115.  
  116. !SysMerge (app)        - Acorn-written utility to upgrade your !System
  117.  
  118. !System (app)        - FreeNews has been written using the new Acorn C
  119.               toolbox. This directory contains the toolbox modules.
  120.               Use this, in association witgh !SysMerge to update 
  121.               your !System.
  122.  
  123.  
  124. Setting up
  125. ----------
  126. I've tried to make this as simple as possible, but one or two things need to be
  127. done before you can successfully use FreeNews.
  128.  
  129. Installation:
  130.         * Copy !FreeNews to the same directory as your other internet utilities.
  131.           Specifically, !NewsBase, !NewsDir (and possibly, !TCPIPUser !) need
  132.           to be seen before FreeNews will run.
  133.           
  134.         * Copy !Newsbase over your existing copy of Newsbase. This archive 
  135.           contains files that will add a "freenews" transport to Newsbase.
  136.  
  137. Newsbase:
  138.     * Edit the file !Newsbase.Transports.freenews.SetHost so that your
  139.       hostname replaces "roundel.demon.co.uk".
  140.     
  141.     * Enter the Newsbase Setup "Transport control" window. Choose
  142.       "freenews" as    the "default news route".
  143.       
  144.     * Ensure that the line "Source transport" in the transport control
  145.       window is set to "freenews", even if you are using KA9Q for mail.
  146.       If this is not done, new group information will not be added to
  147.       NewsBase. YOU HAVE BEEN WARNED. Graham Allan is looking into a fix
  148.       to NewsBase for this at the moment.
  149.     
  150.     * (for Newsbase 0.55 onwards, ensure that for the freenews transport,
  151.       mail checking is inactive, news checking is active and outgoing
  152.       routing is news).
  153.     
  154.     * Save all changes here.
  155.  
  156. FreeNews:
  157.     * Edit the file !FreeNews.Data.AllGroups. This should contain the groups
  158.       that you wish to subscribe to, one per line. The use of "*" at the
  159.       end of a name is valid for wildcard purposes.
  160.       
  161.       Note that the format of the file is <name><TAB>1.
  162.       
  163.       If you are upgrading from KA9Q, take your existing newsfeed file
  164.       (*News, e.g. demnews), copy it to AllGroups, and edit it to add the
  165.       <TAB>1.
  166.       
  167.       If you are upgrading from an earlier version of FreeNews (0.98 and
  168.       before), you must edit this file to include the <TAB>1.
  169.     
  170.     * Run !FreeNews, and open the preferences window. Note that Acorn's
  171.       interactive help is supported here.
  172.     
  173.     * Enter at least one news server name. Ensure the server you wish to use
  174.       is selected by the radio button on the left.
  175.         
  176.     * Enter a date and time for fetching or click on "catch up".
  177.     
  178.     * Choose a speed option. I'd recommend FAST, unless you are experiencing
  179.       memory problems.
  180.     
  181.     * Accept/save these changes by clicking OK.
  182.     
  183.  
  184. Using FreeNews
  185. --------------
  186. Once setup, FreeNews is simple to operate. Choose "Transfer News" from the iconbar
  187. menu to start the process running. The text under the icon (if configured) will
  188. change to indicate progress (or lack of!) For more information, clicking select
  189. on the iconbar icon will open a status window. This status window can also be
  190. opened by selecting the relevant entry on the iconbar menu, or automatically,
  191. according to the preferences.
  192.  
  193. FreeNews will attempt to be clever if you drop your connection part-way through
  194. a fetch. Next time you connect, only those articles that were not downloaded in
  195. full previously will be fetched again.
  196.  
  197. If FreeNews fails for any reason, it should show an error window before dying.
  198. If you find it just removes itself from the icon bar, have a look in the
  199. system_log file (held within !Syslog).
  200.  
  201. If you want to speed things up a little at the expense of debugging information,
  202. Edit the !FreeNews.!Run file and change the parameter on the SyslogD_Debug line.
  203. The lower the number (it goes to zero meaning next to no logging) the less 
  204. disk activity there will be. If you do find a fault, I'd like to see the relevant
  205. bit of the syslog at level 5 or above (pref. level 7).
  206.  
  207. At debug level 0, errors and start/stop are logged. At level 1, Warnings are also
  208. included. Higher levels give progressively more information, such that the
  209. fetching will proceed at a snail's pace. Please do not set to higher than 5 unless
  210. I've asked you to.
  211.  
  212.  
  213. Compatability
  214. -------------
  215. FreeNews should be compatible with *any* standard TCP/IP stack. I've tested it
  216. with Freenet version 0.20 and the ANT Internet suite at 0.45ß. Other beta testers
  217. have used Acorn TCP/IP without problems. FreeNews will *not* work with KA9Q
  218. (aka !TCPTP) or Termite Internet, as these are not standard stacks.
  219.  
  220. Error messages that are displayed whilst running with ANT beta stack with Fresco
  221. are a fault with the Acorn written code within the ANT stack. ANT are aware of 
  222. this.
  223.  
  224.  
  225. The Future
  226. ----------
  227. Just because FreeNews is now stable enough to be numbered above 1.00 does not
  228. mean that this is it. FreeNews is still evolving. My plan of action for the
  229. near future is as follows:
  230.  
  231. * The ability to download headers-only of messages, and browse these at leisure
  232.   to select which articles to fetch. Limited support for this is already present
  233.   (and hidden) within FreeNews 1.01; so expect some support for this fairly soon.
  234.  
  235. * The ability to edit the fetch status of groups (a window exists in 1.01 to
  236.   elicit comments).
  237.  
  238. * The facility of selecting from headers by THREAD rather than individually.
  239.  
  240. * The provision of auto-select and auto-kill functions that will automatically
  241.   download the body of articles that you've already expressed interest in, and
  242.   conversely to "kill" the headers of certain articles after download so you will
  243.   not be shown the header, and the body will not be downloaded.
  244.   
  245. * The facility to associate a cost with individual newsgroups so that high traffic
  246.   groups are only downloaded when telephone calls are cheap, and very low-traffic
  247.   or important groups are fetched regardless of the time.
  248.  
  249.  
  250. Any Questions?
  251. --------------
  252. Or observations/requests? Then please feel free to contact me by email at
  253. freenews@roundel.demon.co.uk.
  254.  
  255.  
  256. Licence
  257. -------
  258. FreeNews is © Copyright 1995 John Smith and Neil Clegg and is released as
  259. freeware.
  260.  
  261. Permission is granted to use FreeNews on the understanding that this use
  262. is entirely at your own risk.  We accept no liability whatsoever for any
  263. loss or damage arising from the use of FreeNews nor do we make any guarantee
  264. that it is fit for any purpose.  You may not distribute FreeNews
  265. in any form without express permission, unless all files are present and
  266. unchanged. No charges may be made (other than reasonable postage/packing costs)
  267. for distribution.
  268.  
  269. PD Libraries and BB sysops should contact me to ensure that they have the latest
  270. version.
  271.  
  272.  
  273. Toolbox Modules
  274. ---------------
  275. FreeNews may have been distributed with Acorn's Toolbox modules.  These
  276. modules are Copyright © Acorn Computers Ltd.  You may not distribute them
  277. unless you have a licence from Acorn to do so.
  278.